Update a User’s Roles

{ updateUserRoles }

Adds or deletes the roles assigned to the selected user.

Method

/API2/access/updateUserRoles

  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2018.5
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin
    • Input Parameters

    Name

    userRolesData

    Object Type

    UserRolesData

    Description

    The user-role object contains a list of all roles to add or remove for the specified user.

    Output Response

    Successful Result Code

    200

    Response List Type

    ItemId[]

    Description of Response Type

    Returns a generic response object with the list of all user's final role IDs. Note that the response is returned as a list of items of this object type.

    Notes

    Provide the list of roles to add and a list of roles to delete for the specified user.